home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / spitfire / sfemb051.zip / SFEMB.DOC < prev    next >
Text File  |  1996-03-19  |  16KB  |  376 lines
  1.  
  2.  
  3.                     SF Enhanced Message Base
  4.                         (Pre 1.0 Version)
  5.                         January 31, 1995
  6.  
  7.                    Written By David D. Turley
  8.  
  9.  
  10.      "Spitfire can now have a full screen editor?  Right..."
  11.  
  12.  
  13.      SF Enhanced Message Base (SFEMB) is a great way to enhance
  14.      your SPITFIRE BBS system!  With the now common 14.4 bps
  15.      modems, the old "line by line" editor and reader that you
  16.      normally use could really use a bit of pizazz.  SFEMB gives
  17.      you that pizazz and more!  With full screen controls,
  18.      editing, and indexes, you'll find your message base open up
  19.      to new possibilities!  Personal BIO's, Alias posting,
  20.      Enhanced message scanning, Internal DOOR loading, Global
  21.      messages, Editing users right in the message base!  All this
  22.      and more!
  23.  
  24.      You'll agree, this is quite a program!  Give it a try and
  25.      see what you think!
  26.  
  27.      ** BETA RELEASE **  This program is in beta form.  Steps are
  28.      taken to preserve data integrity, however some bugs
  29.      unfortunately will be passed on to you, the sysop.  Be
  30.      advised the author takes no responsibility for damage done
  31.      software or hardware as a result of this program.  Use at
  32.      your own risk.
  33.  
  34. USAGE:
  35. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  36.      To upgrade from a previous version of SFEMB, you need to update
  37.      this copy of SFEMB (if shareware).  To do this, place your old
  38.      copy of SFEMB in a safe directory.  Execute your NEW copy of SFEMB
  39.      with the word "REGISTER" after it:
  40.  
  41.      C:\SF>SFEMB REGISTER
  42.  
  43.      You will be asked for the directory you placed your old copy of
  44.      SFEMB in.  Once the new copy of SFEMB confirms the previous
  45.      registration, it will register itself.  If you have any problems,
  46.      please contact the support BBS.
  47.  
  48.      SFEMB is designed to be operated as a DOOR, or from the
  49.      command line.  It gives the sysop and user greater freedom
  50.      with the message base than they've had in the past.  
  51.  
  52.      FORMAT:
  53.  
  54.      C:\SF> SFEMB.EXE [<drive:path>bbsfile.ext [SCAN [FORCE]]]
  55.  
  56.      WHERE:
  57.  
  58.      <drive:path>        The full path location of the bbsfile.
  59.                          (optional)
  60.      bbsfile.ext         The name of the drop file. (eg.
  61.                          SFDOORS.DAT, SFMAIN.DAT, SFMESS.DAT,
  62.                          SFFILE.DAT) (required for DOOR
  63.                          operation, option for command line
  64.                          "local" initiation).
  65.      SCAN                Puts SFEMB into "SCAN" mode.  This is
  66.                          used in a SFLOGON.BAT or similar file. 
  67.                          This can only be executed during a DOOR
  68.                          initiation.
  69.      FORCE               A special "SCAN" mode modifier, it
  70.                          disallows user from aborting a message
  71.                          scan part-way.
  72.               
  73. USAGE EXAMPLES:
  74. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  75.      SFLOGON.BAT Example -
  76.  
  77.      SFEMB.EXE C:\SF\SFDOORS.DAT SCAN FORCE
  78.  
  79.      The above example would load SFEMB and put it into a "Forced
  80.      Scan" mode.  SFEMB will scan all messages in all conferences
  81.      looking for new messages to the logged on user.  If message
  82.      are found, the user can enter the reader/editor and read the
  83.      new messages.
  84.  
  85.      SF.BAT DOOR Example -
  86.  
  87.      DOOR_M
  88.        SFEMB.EXE C:\SF\SFDOORS.DAT
  89.        GOTO LOOP
  90.  
  91.      SFMAIN.BAT MENU EXTENSION Example -
  92.  
  93.      SFEMB.EXE C:\SF\SFMAIN.DAT
  94.  
  95.      DOS Command line initiation example -
  96.  
  97.      SFEMB.EXE
  98.  
  99.      The above examples will load the main SFEMB program.  SFEMB
  100.      will load with all features being active.
  101.  
  102.  
  103. EMB.BAT:
  104. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  105.      SFEMB is a large program.  In order to gain the maximum
  106.      amount of memory for execution of external DOORS, it was
  107.      necessary for SFEMB to completely unload from memory in
  108.      order to execute an external DOOR.  For proper execution of
  109.      external DOORS within SFEMB, you will need to use the
  110.      EMB.BAT (or similar) file.  When an external door is
  111.      selected for loading, SFEMB creates a "state of affairs"
  112.      file called EMBSYS.<node#>.  It then exits with an error
  113.      code notifying the EMB.BAT which door to load.  When the
  114.      external door is finished, SFEMB re-loads and is ready right
  115.      where you left off.
  116.  
  117.      SFEMB is capable of operating up to 15 external DOORS.
  118.  
  119.      SF Sysops are already familiar with this type of external
  120.      DOOR loading, and editing and maintain this file will not be
  121.      a hassle.  We give you the EMB.BAT file as an example to be
  122.      modified or copied to further understand DOOR loading.
  123.  
  124.  
  125. SFEMB.CFG:
  126. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  127.      This file is the heart of SFEMB.  If something is not
  128.      working right, then a good chance is that this file is to
  129.      blame.
  130.      ** NOTE ** SFEMB looks for the SFEMB.CFG in the current
  131.      directory.  If your BBS needs unique SFEMB.CFG files for
  132.      each of its nodes, you are advised to put the .CFG files in
  133.      different directories and start SFEMB from the respective
  134.      directories.
  135.  
  136.      EXAMPLE:
  137.  
  138.      C:\SF\NODE1\SFEMB.CFG
  139.      C:\SF\NODE2\SFEMB.CFG
  140.  
  141.      or
  142.  
  143.      X:\DOORS\SFEMB\NODE1\SFEMB.CFG
  144.      X:\DOORS\SFEMB\NODE4\SFEMB.CFG
  145.                
  146.                              FORMAT:
  147.                              -------
  148.      SFEMB is controlled by several command variables within the
  149.      SFEMB.CFG file.  The format of the .CFG file is as follows:
  150.  
  151.      FORMAT:
  152.  
  153.      <variable>=<argument>;
  154.  
  155.      WHERE:
  156.  
  157.      <variable>          A valid command-variable name.  Note
  158.                          that no spaces may separate the variable
  159.                          and the "=" and the "=" and the
  160.                          argument.  Generally not case sensitive.
  161.      <argument>          The value given to the variable.  Can be
  162.                          case sensitive.
  163.  
  164.      Anywhere in the .CFG file a ";" can be used to denote a
  165.      comment.  Lines beginning with a ";" are considered to be 
  166.      comments.
  167.  
  168.                            VARIABLES:
  169.                            ----------
  170.      The following is a list and explanation of all the valid
  171.      command-variables.
  172.  
  173.      allow.alias         Turns on and off the ALIAS features of
  174.                          SFEMB.  [Default=TRUE]
  175.      allow.quotebox      Turns on and off the QuoteBOX feature of
  176.                          SFEMB.  QuoteBOX is an alternate method
  177.                          of quoting a user with the old "DT> "
  178.                          method.  QuoteBOX is a High-ASCII box
  179.                          that is placed around the quote to give
  180.                          it a more asthetic look. [DEFAULT=TRUE]
  181.      bbs.citystate       Places a line at the end of your messages
  182.                          giving the city/state/country or whatever
  183.                          you wish.  This will be printed on the next
  184.                          line below the TCode.
  185.      beta.bbsname        Tells SFEMB the name of YOUR BBS on a
  186.                          timed beta release.  After the beta
  187.                          period has elapsed for a given beta, the
  188.                          variable will be ignored and SFEMB will
  189.                          report the program as unregistered.
  190.      color.<type>        This is a series of variables allowing
  191.                          the sysop to customize the color set
  192.                          used by SFEMB.  Please look at the
  193.                          supplied SFEMB.CFG for further
  194.                          information.
  195.      common.directory    Where SFEMB expects to find its .HLP
  196.                          files.  It also stores its USERS.EMB
  197.                          file, and the BIO sub-directory there. 
  198.                          All nodes in a multi-node BBS should
  199.                          have the *SAME* common.directory.
  200.                          [Default=C:\SF\WORK]
  201.      default.bbspath     Where SFEMB looks to find the
  202.                          SFMCONF.DAT & SFNODE.DAT during command
  203.                          line initiation.  [Default=C:\SF]  
  204.      default.name        What name SFEMB assumes the active user
  205.                          to be when it is loaded from the command
  206.                          line without a BBS drop file.
  207.                          [Default=Sysop]
  208.      default.security    Security level of the active user during
  209.                          command line initiation. [Default=999]
  210.      default.usernumber  The default user number to assume during
  211.                          command line initiation.  Used to load
  212.                          the correct Last Message Read pointers.
  213.                          [Default=0]
  214.      door_<ltr>.<ecode>  This is a series of variables used to
  215.                          activate the external DOOR features of
  216.                          SFEMB.  The <ltr> corresponds to the
  217.                          letter that option will appear in the
  218.                          menu as.  The <ecode> is the error code
  219.                          the program will result if that option
  220.                          is selected.  Non-used
  221.                          door_<ltr>.<ecode> variables should be
  222.                          commented out by using a leading ";".
  223.      ignore.fossil       Tells SFEMB to ignore any FOSSIL drivers
  224.                          even if it finds some present.
  225.                          [Default=FALSE]
  226.      local.ripview       Points to a .BAT file that will be
  227.                          loaded when a local user wishes to
  228.                          <V>iew a message through a RIP (or ANSI)
  229.                          interpreter.  A copy of the message is
  230.                          passed to the .BAT file as the first
  231.                          parameter to it.
  232.      message.directory   Where SFEMB expects to find all the
  233.                          messages.  All nodes in a multi-node BBS
  234.                          should have the *SAME*
  235.                          message.directory.
  236.                          [Default=C:\SF\MESSAGE]
  237.      overide.bbspath     Overrides the bbs_path supplied by the
  238.                          BBS drop-file.  This may be used to let
  239.                          SFEMB access multiple message bases.
  240.      scan.queue.only     This variable turns on and off the usage
  241.                          of the message Queue during SCAN mode. 
  242.                          If on, any SCAN will only scan the users
  243.                          queued conferences instead of all
  244.                          conferences.
  245.      showlast.msg        In the main menu of SFEMB, it displays
  246.                          the last few message headers (#, to,
  247.                          from, & subject) in a given conference. 
  248.                          This tells SFEMB how many to display. 
  249.                          Too many displayed may cause the screen
  250.                          to scroll unnecessarily.
  251.      sysop.security      Level user must obtain to have full
  252.                          sysop privileges within SFEMB. 
  253.                          *WARNING* Users with sysop status have
  254.                          full access to the user password file.
  255.                          [Default=999]
  256.      turley.code         This variable sets your BBS's TurleyCode
  257.                          so that other users who read messages
  258.                          from your BBS will know what kind of BBS
  259.                          you operate.  (See BBSCODE.TXT for more
  260.                          information)
  261.      use.circuitnet      This instructs SFEMB to look for and use
  262.                          CircuitNET Software routing codes. 
  263.                          [Default=FALSE]
  264.      work.directory      This is where SFEMB puts its temporary
  265.                          work files.  This can be a RAM disk, and
  266.                          might be preferred in order to minimize
  267.                          disk clutter.  [Default=C:\SF]
  268.  
  269. HELP FILES:
  270. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  271.      Help files should all be located in the "common.directory".  If
  272.      not, an error message will be displayed to the user when they 
  273.      attempt to access the help screens.
  274.  
  275.  
  276. NET.ID:
  277. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  278.      SFEMB now adds to the normal information in the conference
  279.      header by adding a NetID byte.  This gives each conference a
  280.      number that identifies it to a specific conference.  This 
  281.      number can be any number 0 through 255.  The number can be
  282.      associated with a name via the NET.ID file.  This is a simple
  283.      text file located in the same directory the MESSAGE base is
  284.      located in. (NOT the SFMCONF.DAT file)  The file format is
  285.      simple:  
  286.  
  287.          <NetID>,<Name>
  288.  
  289.      Example:
  290.   
  291.         0,Local
  292.         1,FIDONet
  293.         2,BingoNet
  294.     10,SFNET
  295.     11,CNFDNet
  296.  
  297.      The NetID number also has meaning.  Numbers 0 & 10-255 are
  298.      considered "Normal" networks.  Conference numbers 1-9 are
  299.      considered to be "LOW ASCII" conferences, and the QuoteBOX
  300.      is not allowed in these conferences.
  301.  
  302. EMB_ERR.LOG:
  303. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  304.      SFEMB creates an EMB_ERR.LOG file and stores in it all of
  305.      the exit code information.  This is used in the beta-testing
  306.      procedure to track errors on certain versions.  This file
  307.      will need to be periodically deleted.  When SFEMB comes to a
  308.      non-progressable error, it will gracefully (hopefully)
  309.      terminate and give store the relevant information in the
  310.      EMB_ERR.LOG.  This information can be forwarded to the
  311.      support BBS for further analysis and problem solving.
  312.  
  313.  
  314. REGISTRATION:
  315. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  316.      There is no time limit to register the software.  You may
  317.      use the unregistered version forever.  You are encouraged to
  318.      register this program if you feel it adds to the value of
  319.      your BBS.  Many shareware authors charge more for their
  320.      programs, but I felt that the low price of $10 would be
  321.      adequate.  The unregistered version is not crippled in any
  322.      way.  Registration gives you free upgrades to all future
  323.      versions.
  324.  
  325.      Registration is easy, just send $10 (check or money order,
  326.      [or cash if you feel lucky] paid to the order of David D.
  327.      Turley) along with the registration form to the name and
  328.      address below.  People receiving disks will also receive a
  329.      copy of all the shareware written by David D. Turley to
  330.      date.  Print the file REGISTER.FRM, fill it out, and send it
  331.      to the following:
  332.  
  333.  
  334.      Send to:  David D. Turley
  335.                4491 West 3500 South C-2
  336.                West Valley City, Utah 84120-3069
  337.  
  338.      *NOTE* Mail sent to the above address is forwarded to the
  339.      authors actual address (I move frequently).  This may
  340.      account for why it may take longer than typical mail time to
  341.      get here.  Registrations are generally done twice monthly,
  342.      however we often get bored and just catch ourselves up with
  343.      everything in to date.  If you are requesting an "uploaded"
  344.      registration, please notate on the registration form when a
  345.      good time of day would be to call your BBS and get on
  346.      without waiting through hours of busy signals.
  347.  
  348. COMMENTS:
  349. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  350.      Any comments or questions concerning SFEMB, or other
  351.      programs written by the author can be sent to the above
  352.      address.  You may reach us on-line, or obtain an instant
  353.      upgrade of any software you have registered from us through
  354.      our Support BBS:  
  355.  
  356.            Sanctuary BBS
  357.            (801) 968-3631, 
  358.            24 hours, v.32/42bis.
  359.  
  360.      Donations of your older hardware (which would improve the
  361.      performance of Sanctuary BBS) may be negotiated with the
  362.      author to obtain free registration of this and other
  363.      software written by the author.  Please inquire with the
  364.      author, David D. Turley for more information.
  365.  
  366. DISCLAIMER:
  367. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  368.      Use SFEMB at your own risk.  The author of SFEMB takes no
  369.      responsibility for damage caused to your hardware or
  370.      software, caused in anyway by SFEMB or its related files. 
  371.      Always check new software with virus checkers before using
  372.      them.
  373.  
  374.      All software mentioned in this document are copyrighted to
  375.      their respective owners.
  376.